Loading TOC...

MarkLogic Server 11.0 Product Documentation
PUT /manage/v2/tasks/{id}/properties

Summary

This resource address can be used to update the properties for the specified task.

URL Parameters
group-id The id or name of the group to which the task belongs. The group must be specified by this parameter or by the group-name property in the request payload. If it is specified in both places, the values must be the same.
format The format of the posted data. Can be either json (default) or xml. This value overrides the Accept header if both are present.
kind The kind of privilege. Can be either execute or uri.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body, either application/xml or application/json.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, either application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 204 (No Content). If the payload is malformed or the privilege does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires one of the following:

The security role is required to set the task-user property.

Usage Notes

The only property that can be modified is task-enabled. The rest of properties listed below are read-only.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, task-days is expressed in singular form. For example, in JSON, task-days is instead task-day and the format is as shown in the following example.

scheduled-task-relations

The relations of the scheduled task.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A group or host related to the server.

task-id

The task ID.

task-enabled

Whether or not a task is enabled

task-path

The module to invoke.

task-root

The path to the module directory root.

task-type

What type of scheduled task is this.

task-period

How often this task should run (every n months, weeks, days, hours or minutes).

task-month-day

The day of the month that this task runs on.

task-days

The days that this task runs on.

This is a complex structure with the following children:

task-day

A day that this task runs on.

task-start-date

The starting date (in MM/DD/YYYY notation) for this task.

task-start-time

The starting time (in 24:00 notation) for this task.

task-timestamp

The date and time this task was created.

task-user

The user to run this task as.

task-priority

The priority of this task.

Example


curl -X PUT  --anyauth -u admin:admin -H "Content-Type:application/json" \
-d '{"task-enabled": false}' \
http://localhost:8002/manage/v2/tasks/15443907690397240566/properties?group-id=Default
 
==>  Changes the "task-enabled" of the task, "15443907690397240566," to "false".

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.